home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / Shell.z / Shell
Encoding:
Text File  |  2002-10-03  |  13.4 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      SSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       SSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           SSSShhhheeeellllllll - The Shell widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           #include <Xm/Xm.h>
  13.           #include <X11/Shell.h>
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents Motif 2.1.
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           Shell is a top-level widget (with only one managed child)
  20.           that encapsulates the interaction with the window manager.
  21.  
  22.           At the time the shell's child is managed, the child's width
  23.           is used for both widgets if the shell is unrealized and no
  24.           width has been specified for the shell. Otherwise, the
  25.           shell's width is used for both widgets. The same relations
  26.           hold for the height of the shell and its child.
  27.  
  28.         CCCCllllaaaasssssssseeeessss
  29.           Shell inherits behavior and resources from CCCCoooommmmppppoooossssiiiitttteeee and
  30.           CCCCoooorrrreeee.
  31.  
  32.           The class pointer is _s_h_e_l_l_W_i_d_g_e_t_C_l_a_s_s.
  33.  
  34.           The class name is SSSShhhheeeellllllll.
  35.  
  36.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  37.           The following table defines a set of widget resources used
  38.           by the programmer to specify data. The programmer can also
  39.           set the resource values for the inherited classes to set
  40.           attributes for this widget. To reference a resource by name
  41.           or by class in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  42.           prefix and use the remaining letters. To specify one of the
  43.           defined values for a resource in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove
  44.           the XXXXmmmm prefix and use the remaining letters (in either
  45.           lowercase or uppercase, but include any underscores between
  46.           words).  The codes in the access column indicate if the
  47.           given resource can be set at creation time (C), set by using
  48.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  49.           not applicable (N/A).
  50.  
  51.                                                    SSSShhhheeeellllllll RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  52.           NNNNaaaammmmeeee                      CCCCllllaaaassssssss                     TTTTyyyyppppeeee                     DDDDeeeeffffaaaauuuulllltttt          AAAAcccccccceeeessssssss
  53.           XmNallowShellResize       XmCAllowShellResize       Boolean                  False            CG
  54.           XmNcreatePopupChildProc   XmCCreatePopupChildProc   XtCreatePopupChildProc   NULL             CSG
  55.           XmNgeometry               XmCGeometry               String                   NULL             CSG
  56.           XmNoverrideRedirect       XmCOverrideRedirect       Boolean                  False            CSG
  57.           XmNpopdownCallback        XmCCallback               XtCallbackList           NULL             C
  58.  
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      SSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       SSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))
  71.  
  72.  
  73.  
  74.           XmNpopupCallback          XmCCallback               XtCallbackList           NULL             C
  75.           XmNsaveUnder              XmCSaveUnder              Boolean                  False            CSG
  76.           XmNvisual                 XmCVisual                 Visual *                 CopyFromParent   CSG
  77.  
  78.           XXXXmmmmNNNNaaaalllllllloooowwwwSSSShhhheeeellllllllRRRReeeessssiiiizzzzeeee
  79.                     Specifies that if this resource is False, the
  80.                     Shell widget instance returns XXXXttttGGGGeeeeoooommmmeeeettttrrrryyyyNNNNoooo to all
  81.                     geometry requests from its children.  All Motif
  82.                     convenience create dialog functions override this
  83.                     default value and set XXXXmmmmNNNNaaaalllllllloooowwwwSSSShhhheeeellllllllRRRReeeessssiiiizzzzeeee to True.
  84.  
  85.           XXXXmmmmNNNNccccrrrreeeeaaaatttteeeePPPPooooppppuuuuppppCCCChhhhiiiillllddddPPPPrrrroooocccc
  86.                     Specifies the pointer to a function that is called
  87.                     when the Shell widget instance is popped up by
  88.                     XXXXttttPPPPooooppppuuuupppp.  The function creates the child widget
  89.                     when the shell is popped up instead of when the
  90.                     application starts up.  This can be used if the
  91.                     child needs to be reconfigured each time the shell
  92.                     is popped up.  The function takes one argument,
  93.                     the popup shell, and returns no result.  It is
  94.                     called after the popup callbacks specified by
  95.                     XXXXmmmmNNNNppppooooppppuuuuppppCCCCaaaallllllllbbbbaaaacccckkkk.
  96.  
  97.           XXXXmmmmNNNNggggeeeeoooommmmeeeettttrrrryyyy
  98.                     Specifies the desired geometry for the widget
  99.                     instance. This resource is examined only when the
  100.                     widget instance is unrealized and the number of
  101.                     its managed children is changed. It is used to
  102.                     change the values of the XXXXmmmmNNNNxxxx, XXXXmmmmNNNNyyyy, XXXXmmmmNNNNwwwwiiiiddddtttthhhh, and
  103.                     XXXXmmmmNNNNhhhheeeeiiiigggghhhhttttresources.  When XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss is called on
  104.                     this resource, the returned value is a pointer to
  105.                     the actual resource value and should not be freed.
  106.                     In addition, this resource is not copied on
  107.                     creation or by XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss. The application must
  108.                     ensure that the string remains valid until the
  109.                     shell is realized.
  110.  
  111.           XXXXmmmmNNNNoooovvvveeeerrrrrrrriiiiddddeeeeRRRReeeeddddiiiirrrreeeecccctttt
  112.                     If True, specifies that the widget instance is a
  113.                     temporary window that should be ignored by the
  114.                     window manager. Applications and users should not
  115.                     normally alter this resource.
  116.  
  117.           XXXXmmmmNNNNppppooooppppddddoooowwwwnnnnCCCCaaaallllllllbbbbaaaacccckkkk
  118.                     Specifies a list of callbacks that is called when
  119.                     the widget instance is popped down by XXXXttttPPPPooooppppddddoooowwwwnnnn.
  120.  
  121.           XXXXmmmmNNNNppppooooppppuuuuppppCCCCaaaallllllllbbbbaaaacccckkkk
  122.                     Specifies a list of callbacks that is called when
  123.                     the widget instance is popped up by XXXXttttPPPPooooppppuuuupppp.  The
  124.                     second argument to XXXXttttPPPPooooppppuuuupppp must be XXXXttttGGGGrrrraaaabbbbNNNNoooonnnneeee.
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      SSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       SSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))
  137.  
  138.  
  139.  
  140.           XXXXmmmmNNNNssssaaaavvvveeeeUUUUnnnnddddeeeerrrr
  141.                     If True, specifies that it is desirable to save
  142.                     the contents of the screen beneath this widget
  143.                     instance, avoiding expose events when the instance
  144.                     is unmapped. This is a hint, and an implementation
  145.                     may save contents whenever it desires, including
  146.                     always or never.
  147.  
  148.           XXXXmmmmNNNNvvvviiiissssuuuuaaaallll Specifies the visual used in creating the widget.
  149.  
  150.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  151.           Shell inherits behavior and resources from the superclass
  152.           described in the following table.  For a complete
  153.           description of each resource, refer to the reference page
  154.           for that superclass.
  155.  
  156.                                   CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  157.           NNNNaaaammmmeeee                CCCCllllaaaassssssss               TTTTyyyyppppeeee          DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  158.           XmNchildren         XmCReadOnly         WidgetList    NULL      G
  159.           XmNinsertPosition   XmCInsertPosition   XtOrderProc   NULL      CSG
  160.           XmNnumChildren      XmCReadOnly         Cardinal      0         G
  161.  
  162.                                                         CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  163.           NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  164.           XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                CSG
  165.           XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  166.           XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  167.           XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  168.           XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  169.           XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  170.           XmNborderWidth                  XmCBorderWidth                  Dimension        0                      CSG
  171.           XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  172.           XmNdepth                        XmCDepth                        int              dynamic                CG
  173.           XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  174.           XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  175.           XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  176.           XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  177.           XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  178.           XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  179.           XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  180.           XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  181.           XmNx                            XmCPosition                     Position         0                      CSG
  182.           XmNy                            XmCPosition                     Position         0                      CSG
  183.  
  184.         TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  185.           There are no translations for Shell.
  186.  
  187.      RRRREEEELLLLAAAATTTTEEEEDDDD
  188.           CCCCoooommmmppppoooossssiiiitttteeee(3) and CCCCoooorrrreeee(3).
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.